Skip to content

docs: Add json_tree UDTF to JSON SQL reference#1747

Merged
lukekim merged 1 commit into
trunkfrom
docs/json-tree-udtf
May 20, 2026
Merged

docs: Add json_tree UDTF to JSON SQL reference#1747
lukekim merged 1 commit into
trunkfrom
docs/json-tree-udtf

Conversation

@claudespice
Copy link
Copy Markdown
Collaborator

Summary

Adds documentation for the json_tree table function shipped in spiceai/spiceai#10406. The function is a schema-agnostic sibling of flatten_json_properties and mirrors the json_tree table function in DuckDB and SQLite (depth-first node walk with a parent pointer).

Source PRs

Changes

  • website/docs/reference/sql/json.md — new json_tree section under "JSON Table Functions (UDTFs)". Documents column schema, the three named options (max_depth, max_rows, max_bytes) accepted in the UDTF form, and the dual UDTF / scalar-UDF registration.

flatten_json and flatten_json_properties were already documented; json_tree was the missing piece.

Test plan

  • cd website && npm run build passes locally
  • Verified examples work locally
  • Links are valid
  • Version references are correct

Adds a json_tree section to the JSON Table Functions reference. The
function ships unconditionally as both a UDTF and a scalar UDF, mirroring
the json_tree table function in DuckDB and SQLite.

Source: spiceai/spiceai#10406
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 19, 2026

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

@github-actions
Copy link
Copy Markdown

🚀 deployed to https://1502e00a.spiceai-org-website.pages.dev

@lukekim lukekim merged commit b906a56 into trunk May 20, 2026
6 of 8 checks passed
@lukekim lukekim deleted the docs/json-tree-udtf branch May 20, 2026 00:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants